Esx Settings Clusters Configuration ApplyResult

Esx Settings Clusters Configuration ApplyResult
Esx Settings Clusters Configuration ApplyResult

The Esx Settings Clusters Configuration ApplyResult schema contains properties that describe the result of an POST /esx/settings/clusters/{cluster}/configuration?action=apply operation.

This schema was added in vSphere API 8.0.1.0.

JSON Example
{
    "status": {
        "status": "string",
        "attempts": 0,
        "remaining_retries": 0,
        "start_time": "string",
        "end_time": "string",
        "notifications": {
            "info": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ],
            "warnings": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ],
            "errors": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ]
        }
    },
    "commit": "string",
    "software_commit": "string",
    "host_info": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "host_status": {
        "host_status": {
            "status": "string",
            "attempts": 0,
            "remaining_retries": 0,
            "start_time": "string",
            "end_time": "string",
            "notifications": {
                "info": [
                    {
                        "type": "string",
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "originator": "string",
                        "retriable": false
                    }
                ],
                "warnings": [
                    {
                        "type": "string",
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "originator": "string",
                        "retriable": false
                    }
                ],
                "errors": [
                    {
                        "type": "string",
                        "id": "string",
                        "time": "string",
                        "message": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "resolution": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "originator": "string",
                        "retriable": false
                    }
                ]
            }
        }
    },
    "successful_hosts": [
        "string"
    ],
    "failed_hosts": [
        "string"
    ],
    "skipped_hosts": [
        "string"
    ]
}
status
Optional

Specifies the aggregated status of the POST /esx/settings/clusters/{cluster}/configuration?action=apply operation.

This property was added in vSphere API 8.0.1.0.

missing or null if the POST /esx/settings/clusters/{cluster}/configuration?action=apply operation is in progress.

string
commit
Required

The identifier of the commit used to fetch the desired configuration document to be applied to all hosts within the cluster.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

string
software_commit
Required

The current commit ID for the software associated with the cluster.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

object
host_info
Required

Information of the hosts in this cluster to which the desired configuration document specified by the Esx Settings Clusters Configuration ApplyResult.commit should be applied to.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.

object
host_status
Required

Status of the hosts in this cluster to which the desired configuration specified by the Esx Settings Clusters Configuration ApplyResult.commit was applied to. Hosts on which the POST /esx/settings/clusters/{cluster}/configuration?action=apply operation was successful are specified by Esx Settings Clusters Configuration ApplyResult.successful_hosts. Hosts on which the apply operation failed are specified by Esx Settings Clusters Configuration ApplyResult.failed_hosts. Hosts which were skipped by the POST /esx/settings/clusters/{cluster}/configuration?action=apply operation are specified by Esx Settings Clusters Configuration ApplyResult.skipped_hosts.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.

array of string
successful_hosts
Required

Hosts in this cluster to which the desired configuration specified by the Esx Settings Clusters Configuration ApplyResult.commit has been successfully applied to.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string
failed_hosts
Required

Hosts in this cluster to which the desired configuration specified by the Esx Settings Clusters Configuration ApplyResult.commit failed to be applied.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string
skipped_hosts
Required

Hosts in this cluster that were skipped by the POST /esx/settings/clusters/{cluster}/configuration?action=apply operation.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.